View Javadoc

1   /*
2    * TouchGraph LLC. Apache-Style Software License
3    *
4    *
5    * Copyright (c) 2001-2002 Alexander Shapiro. All rights reserved.
6    *
7    * Redistribution and use in source and binary forms, with or without
8    * modification, are permitted provided that the following conditions
9    * are met:
10   *
11   * 1. Redistributions of source code must retain the above copyright
12   *    notice, this list of conditions and the following disclaimer. 
13   *
14   * 2. Redistributions in binary form must reproduce the above copyright
15   *    notice, this list of conditions and the following disclaimer in
16   *    the documentation and/or other materials provided with the
17   *    distribution.
18   *
19   * 3. The end-user documentation included with the redistribution,
20   *    if any, must include the following acknowledgment:  
21   *       "This product includes software developed by 
22   *        TouchGraph LLC (http://www.touchgraph.com/)."
23   *    Alternately, this acknowledgment may appear in the software itself,
24   *    if and wherever such third-party acknowledgments normally appear.
25   *
26   * 4. The names "TouchGraph" or "TouchGraph LLC" must not be used to endorse 
27   *    or promote products derived from this software without prior written 
28   *    permission.  For written permission, please contact 
29   *    alex@touchgraph.com
30   *
31   * 5. Products derived from this software may not be called "TouchGraph",
32   *    nor may "TouchGraph" appear in their name, without prior written
33   *    permission of alex@touchgraph.com.
34   *
35   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38   * DISCLAIMED.  IN NO EVENT SHALL TOUCHGRAPH OR ITS CONTRIBUTORS BE 
39   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
40   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
41   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
42   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
43   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
44   * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
45   * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46   * ====================================================================
47   *
48   */
49  
50  package com.touchgraph.graphlayout.interaction;
51  
52  import java.awt.event.*;
53  
54  import com.touchgraph.graphlayout.TGPanel;
55  
56  /*** TGAbstractDragUI allows one to write user interfaces that handle
57    * what happends when a mouse is pressed, dragged, and released.
58    *
59    * @author   Alexander Shapiro
60    * @version  1.21  $Id: TGAbstractDragUI.java,v 1.1.1.1 2004/02/06 08:44:07 keesj Exp $
61    */
62  public abstract class TGAbstractDragUI extends TGSelfDeactivatingUI {
63  
64      public TGPanel tgPanel;
65  
66      private ADUIMouseListener ml;
67      private ADUIMouseMotionListener mml;
68      public boolean mouseWasDragged; //To differentiate between mouse pressed+dragged, and mouseClicked
69  
70    // ............
71  
72     /*** Constructor with TGPanel <tt>tgp</tt>.
73       */
74      public TGAbstractDragUI(TGPanel tgp) {
75          tgPanel=tgp;
76          ml =new ADUIMouseListener();
77          mml=new ADUIMouseMotionListener();
78      }
79  
80       public final void activate() {
81          preActivate();
82          tgPanel.addMouseListener(ml);
83          tgPanel.addMouseMotionListener(mml);
84          mouseWasDragged=false;
85       }
86  
87      public final void activate(MouseEvent e) {
88          activate();
89          mousePressed(e);
90      }
91  
92      public final void deactivate() {
93          preDeactivate();
94          tgPanel.removeMouseListener(ml);
95          tgPanel.removeMouseMotionListener(mml);
96          super.deactivate(); //To activate parentUI from TGUserInterface
97      }
98  
99      public abstract void preActivate();
100     public abstract void preDeactivate();
101 
102     public abstract void mousePressed( MouseEvent e );
103     public abstract void mouseDragged( MouseEvent e );
104     public abstract void mouseReleased( MouseEvent e );
105 
106 
107     private class ADUIMouseListener extends MouseAdapter {
108         public void mousePressed(MouseEvent e) {
109             TGAbstractDragUI.this.mousePressed(e);
110         }
111 
112         public void mouseReleased(MouseEvent e) {
113             TGAbstractDragUI.this.mouseReleased(e);
114             if (selfDeactivate) deactivate();
115         }
116     }
117 
118     private class ADUIMouseMotionListener extends MouseMotionAdapter {
119         public void mouseDragged(MouseEvent e) {
120             mouseWasDragged=true;
121               TGAbstractDragUI.this.mouseDragged(e);
122         }
123     }
124 
125 } // end com.touchgraph.graphlayout.interaction.TGAbstractDragUI